Upgrade or Downgrade Customer License

This request enables you to do one of the following:

■

Upgrade the customer license type from Direct Routing Essential Plus to Direct Routing Pro.

■

Downgrade the customer license type from Direct Routing Pro to Direct Routing EssentialsPlus

■

Upgrade the customer license type from OC EssentialPlus to OC Pro.

■

Downgrade the customer license type from OC Pro to OC EssentialsPlus.

URI

Copy

{{baseUrl}}/api/v3/customer/{umpCustomerGuid}

HTTP Method

PATCH

Request Parameters

Parameter	Type	Description
CustomerGuid	string($uuid)	This id is created in the Live Platform database for the customer tenant when a Live Platform license is applied. If this field is null, a license has not yet been applied to the lead. This value is also obtained in the 'Get Task' response when the customer is created.

Request Body

Parameter

Type

Description

upgradeToLicense

integer

One of the following values:

■

1: Hosted Essentials Plus

■

2: Hosted Pro

■

4: OC Essential Plus

■

5: OC Pro

licensedUsersCount

integer

The number of licensed users to configure for the customer service.

Example Request Body

Copy

{
  "licenseType": 5
}

Example Response

Copy

HTTP Responses

■

200 OK

■

400 Bad Request: When the 'upgradetoLicense' parameter is configured with an invalid value:

Copy

{
  "licenseType": 7
}

The following error is displayed:

Copy

"Invalid change for License Type!"

See 'upgradeToLicense' parameters shown above for valid types.